home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / clipper / hlpsy203.zip / HELPSYS2.DOC < prev    next >
Text File  |  1994-03-10  |  28KB  |  676 lines
  1.                        HELPSYS 2.03
  2.                               
  3.                     (c)1994 - Jeff Lewis
  4.  
  5.                               
  6.      This product is being released as a Shareware product.  This
  7. means that the shareware version of the program may be freely copied
  8. and evaluated by anyone.  If you decide that this product will suit
  9. your needs, simply send a $30.00 donation to us and we will send you a
  10. more powerful version of the software that lets you have more control.
  11. Also included will be several functions that allow window
  12. manipulation, printing, database and video stack saving.  These will
  13. be documented and include sample programs on usage.
  14.  
  15.      Send an additional $10.00 for FULL Source Code.
  16.      
  17.      This HelpSys module was designed for quick and easy help screens
  18. without adding a single line of code to your Clipper 5.01 or Clipper
  19. 5.2 application.  Simply link in the object file, include the
  20. HELPSYS2.LIB file and create your help text file.  That's all there is
  21. to it. You'll have field level help with out much work or effort on
  22. your part.
  23.  
  24.      Also included in this package is a networking module that makes
  25. networking tasks easier to manage.  Several other functions are
  26. currently being prepared to add to this library.  The concept here is
  27. that when you register for the HelpSys2 product, youÆll automatically
  28. be registered for the other products that make their way into this
  29. library.  When obtaining Source Code for HelpSys 2.x you receive
  30. source code for all libraries included.
  31.  
  32.      The Shareware version does NOT contain some of the help control
  33. modules and window printing modules.  This version is also slightly
  34. crippled, when pressing F1 to invoke the help screen(s), you can only
  35. bring up the help screens a total of 10 times per application
  36. execution.  This should be more than sufficient for your testing.
  37. Also, upon registering, for an additional $10.00 I will send you full
  38. Source Code that you can modify as needed.  I know that when
  39. developing, I always feel more comfortable about my application when
  40. using libraries that I have control over.  You will not be allowed to
  41. distribute the source code or object code for the registered version
  42. of this software.
  43.  
  44.      The majority of these functions are FULLY functional, no anoying
  45. messages or restrictions.  You can test these functions in your programs
  46. for a period of 30 days.  After that you are required to register this
  47. software.
  48.  
  49.      Registered users of HelpSys 1.1 can upgrade for the difference    
  50. price ($10.00).  Also, upon registering, if you've received source     
  51. code for HelpSys 1.1, you will also receive source code for 2.x for no 
  52. additional cost to you.                                                
  53.  
  54. Features:
  55.      Network Ready!
  56.      Norton Guide compatible Help File
  57.      Press F1 for help from any screen and field
  58.      Help Key is redefinable
  59.      On-Line help without any additional programming
  60.      Field Level Help with a professional look
  61.      Procedural level help for non-field entries
  62.      Capable of Several Screens of help per field, not just one
  63.      Intelligent help window moving when help window covers the current field
  64.      Multi-level Help
  65.      Automatic  Help Topics index is displayed when no further help is
  66.         available
  67.      Toggle between Development and User modes while developing on-line help
  68.      Window and Text Color Control
  69.      Window Positioning Control
  70.  
  71. Additional Features after registering:
  72.      Generic Window functions that can be used in your own programs
  73.      (including printing within a window)
  74.      Network Functions with status messaging
  75.      Video Stack function calls
  76.      Database Stack function calls
  77.      Quick Alert Printing function
  78.      [Optional Source Code written entirely in Clipper 5]
  79.      Get the complete CURRENT VERSION                               
  80.      SUPPORT                                                        
  81.  
  82. Why should I register?
  83.  
  84.      I feel that after all this work and effort, $30.00 is a minimal
  85. charge for providing such capabilities (+ $10.00 if you want the
  86. source code).  There are several other routines that I've written over
  87. the past several years that I'll plan on releasing as Shareware
  88. (including software security routines).  This is to everyoneÆs
  89. advantage.  Upon registering, you'll be registered for Network and
  90. other libraries that migrate their way into the HelpSys 2.x series.
  91.  
  92. [For International Orders, please include and additional $5.00 US
  93. Funds for shipping outside USA]
  94.  
  95.      When registering, please provide me with your Compuserve or
  96. Internet account name or address if you have one.  This will allow me
  97. to send minor updates free (other than CIS, Internet or postage
  98. charges).
  99.  
  100. Jeff Lewis
  101. P.O. Box 441456
  102. Indianapolis, Indiana  46244
  103.  
  104.      CIS: 70711,3030
  105. INTERNET: JLEWIS@HYRAX.IUPUI.EDU
  106.  
  107.               HelpSys 2.0x - For the Developer
  108.  
  109.      Initially you will need to tell HelpSys 2.0 that you are a
  110. developer.  You can do this by setting the environment variable
  111. HELPMODE to any value at the command prompt.
  112.  
  113.      i.e.
  114.  
  115.      SET HELPMODE=DEVELOPER
  116.  
  117.       When starting from scratch on a help database, you will need a  
  118.  HelpSys database created for you.  This is done automatically when   
  119.  invoking HelpSys 2.xx AND in DEVELOPER MODE.                         
  120.  
  121.      Once this has been entered and HelpSys2 is invoked from your
  122. application (via the F1 key) you will see a message appear in the
  123. upper left corner of the screen [Developer Mode].  This enables you to
  124. press F1 anytime you want to edit existing help or create additional
  125. help screens.  When a new help screen is created, you will be notified
  126. via an alert.  You can then edit the help (or blank help window) and
  127. press ESC when done.  It will automatically be saved at that point.
  128.  
  129.      The F2 key is available to toggle between Developer mode and User
  130. mode while developing your application level help.  In other words,
  131. when HELPSYS is invoked AND HELPMODE has been set the F2 key becomes
  132. active.  When in Developer mode, you can add Help Screens.  When in
  133. the User mode, when no more help is available, a Help Topics list will
  134. automatically appear or all available help.  Also, since the HELPMODE
  135. was defined you can delete unwanted Help Screens by pressing the DEL
  136. key on the highlighted help topic and confirming the 'Are you sure you
  137. want to delete this entry?' question.
  138.  
  139.      The Help Topics list will appear when no help is available while
  140. HELPMODE has not been assigned (no deleting will be allowed if
  141. HELPMODE is not defined) or while in User mode.  The help topic is
  142. ALWAYS the FIRST LINE IN THE HELP SCREEN.
  143.  
  144. Program Notes:
  145.  
  146.      When Linking include HELPSYS2.OBJ with your program and include
  147. HELPSYS2.LIB
  148. [NOTE: If your using Clipper 5.01 use the HELPSYS1.OBJ and HELPSYS1.LIB
  149.        files instead of HELPSYS2.xxx]
  150.  
  151.  RTLINK FILE TEST.OBJ,HELPSYS2.OBJ LIB HELPSYS2  
  152.      or                                          
  153.  BLINKER FI TEST.OBJ HELPSYS2.OBJ LIB HELPSYS2   
  154.  
  155. Using other RDD's
  156.  
  157. Using index or memo file formats other than .NTX or .DBT
  158.  
  159.      HelpSys 2.xx does not have any hardcoded database or index
  160. extensions.  This means that you can use any CLIPPER RDD compliant
  161. product.  HelpSys 2.xx has been tested with FLEXFILE II and COMIX.
  162.  
  163.      The beginning code segment in the main application looked like
  164. the following:
  165.  
  166.  Example Beginning Code for FlexFile usage
  167.  .                                                                      
  168.  .                                                                      
  169.  REQUEST FLEXFILE              // Use FlexFile as the primary DB Drive  
  170.  RDDSETDEFAULT("FLEXFILE")     // and Default                           
  171.  .                                                                      
  172.  .                                                                      
  173.  
  174.  
  175.  Example Beginning Code for Comix usage
  176.  
  177.  .                                                                      
  178.  .